home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d20 / ffix121.arc / FILEFIX.DOC < prev    next >
Text File  |  1991-05-15  |  14KB  |  397 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.                                   FileFix 1.20
  9.                                   ------------
  10.  
  11.                             Released March 31, 1991
  12.                        Copyright (C) Stig Jacobsen, 1990
  13.  
  14.  
  15.  
  16.     Introduction
  17.          This documentation assumes familiarity with AreaFix. It also
  18.          assumes that you are familiar with the FidoNet software
  19.          "standard", which - among other things - means weird control-
  20.          files, lots of bugs and thin documentation.
  21.          If you do not hold these prerequisites, stop here. I'm not going
  22.          to give FileFix lessons via netmail or echomail, so if you insist
  23.          on using it (even though you don't understand it), you should seek
  24.          help elsewhere.
  25.          I would however, very much like to know about any bugs that you
  26.          encounter. Note: Anything that you don't understand, isn't
  27.          necessarily a bug!
  28.  
  29.  
  30.     About this document
  31.          Since I absolutely do not like writing documentation, this file is
  32.          not likely to be updated very often. If you cannot find the
  33.          information that you need in here, please read FILEFIX.CFG and
  34.          FILEFIX.NWS carefully.
  35.          If you feel that you could write some better documentation than
  36.          this, you're very welcome to drop me a netmail message.
  37.  
  38.  
  39.     What is it?
  40.          Well.. YAFR - Yet Another File Robot. No, wait, don't go away! It
  41.          has some rather nice features besides the usual boring ones.
  42.            o  It has an AreaFix-like interface, which allows your
  43.               nodes/points to connect/disconnect from files themselves by
  44.               the way of netmail messages.
  45.            o  It will automatically insert new files into Files.Bbs at a
  46.               suitable place (which is not at the end!) and with a suitable
  47.               description (which is not "(description missing)"!).
  48.            o  It will automatically move new files from your netfile
  49.               directory to wherever on your disk(s) that you really would
  50.               like them to end up.
  51.            o  It has a history feature, which allows you to answer such
  52.               complaints as "It is *ages* since I got a FidoNews issue"
  53.               with an answer like "FileFix attached you FNEWS712 this
  54.               wednesday at 5:40!" - within a matter of seconds.
  55.            o  It has a report feature, which quickly permits you to see
  56.               exactly which nodes are receiving which files.
  57.            o  Have you noticed how boring the usual messages from file-
  58.               robots are? Well, not so anymore. If you tell FileFix where
  59.               to find its fortune cookie file (Opus terminology: "Quote
  60.               file"), it will send cookies to your nodes as it is sending
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73.               file-attaches.
  74.            o  You can define batch command sequences within its
  75.               configuration file, which is automatically evoked whenever a
  76.               matching file is found in your netfile directory. No more
  77.               endless 'if exist' sequences within your batch-files (no more
  78.               batch-files for that matter...).
  79.            o  It will, upon request, check the file-date of incoming files,
  80.               and refuse to forward them if they are older than a specified
  81.               age (nobody wants to have a FNEWS322 which slipped out by
  82.               mistake, etc.).
  83.            o  It will keep track of file-attaches which are never picked up
  84.               by your nodes, and delete them after a specified time. NOTE:
  85.               This feature is nonfunctional on systems employing static
  86.               packers.
  87.            o  If needed, it can be told to only forward certain files on
  88.               certain weekdays.
  89.            o  Option to use X_List compatible forwarding by date (only
  90.               files with a date later than last FileFix run, are
  91.               forwarded).
  92.  
  93.  
  94.     General
  95.          FileFix has a number of functions. The FORWARD function works as a
  96.          file-robot, creating file-attaches for nodes (and points)
  97.          subscribing to a file, and moving the file from your netfile
  98.          directory to its destination directory (usually somewhere where
  99.          your users can download it). The SCAN function checks your netmail
  100.          area for messages to FileFix, and adds or deletes nodes from the
  101.          subscription lists (FileFix.Are) as indicated by the nodes
  102.          themselves (zero maintenance for you). The REPORT function will
  103.          generate a simple report over which files your nodes/point are
  104.          currently receiving. The LIST function is for inquiring as to when
  105.          which nodes got which files.
  106.  
  107.  
  108.     Targets
  109.          FileFix was tested on my own system, which runs FrontDoor 1.99c.
  110.          Systems using static packers (QMail, oMMM) will notice that some
  111.          options will have no effect - currently the 'KeepDays' option
  112.          requires a dynamic packer to work. 
  113.  
  114.  
  115.     Usage
  116.          FileFix [options] <SCAN|FORWARD|BOTH|REPORT|LIST|PACK> [argument]
  117.  
  118.  
  119.     Options
  120.          -a<areas-file> Use alternate areas file (default is FILEFIX.ARE).
  121.          -c<cfg-file>   Use alternate configuration file (default
  122.                         FILEFIX.CFG).
  123.          -r             Also process those netmail messages that are marked
  124.                         received.
  125.          -v             Verbose mode - more information on the screen.
  126.          -x             Don't make use of new fields (FTS-0001.A12) in
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.  
  137.  
  138.  
  139.                         message header. ME2 users will probably want to use
  140.                         this switch.
  141.          -?             Display help on commandline (you also get help if
  142.                         you run FileFix without any arguments).
  143.  
  144.  
  145.     Commands
  146.          SCAN      Check netmail directory for new messages to FileFix and
  147.                    process them, updating FileFix.Are and sending back
  148.                    receipts as required. Also, if 'KeepDays' is in effect,
  149.                    pending outgoing messages will have their age tested.
  150.          FORWARD   Check netfile directory for new files known to FileFix,
  151.                    moving them to their destination directories, and
  152.                    creating file attach messages as required.
  153.          BOTH      Same as SCAN + FORWARD.
  154.          REPORT    Generate report of which nodes are receiving which
  155.                    files. By default the report will go to CON (the
  156.                    screen), but you can give a filename as the next
  157.                    argument, and it will go to that file instead.
  158.          LIST      Display the history file in backwards order, that is,
  159.                    the most recent transactions are displayed first. By
  160.                    default FileFix will display all nodes, but you can
  161.                    supply a node-number as the next argument, and it will
  162.                    only list this nodes transactions.
  163.          PACK      Purge old entries from history file. By default, the
  164.                    PACK command will retain 90 days of history - you can
  165.                    give a different number of days as the next argument.
  166.  
  167.  
  168.     Examples
  169.          FileFix -cmy.cfg -x both
  170.          FileFix -atmp.are scan
  171.          FileFix report prn
  172.          FileFix list .23
  173.          FileFix forward
  174.          FileFix pack
  175.          FileFix pack 14
  176.  
  177.  
  178.     Files
  179.          FileFix.Cfg -  Default configuration for FileFix.
  180.          FileFix.Are -  Default areas-file - like Areas.Bbs, but for files.
  181.                         Initially created by you, and afterwards maintained
  182.                         by FileFix (as per directions by your
  183.                         nodes/points).
  184.          Both files must both be in the current directory. FileFix.Are will
  185.          automatically be updated by FileFix, if any valid change requests
  186.          were received from your nodes.
  187.  
  188.  
  189.     Meta strings for 'AttachMsg'
  190.          Most of these are the same as for X_List.
  191.  
  192.          %magic    Magic name for the file
  193.  
  194.  
  195.  
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.  
  203.  
  204.  
  205.          %descript Description of the file
  206.          %cookie   Cookie of the day
  207.          %dzone    Destination zone
  208.          %dnet     Destination net
  209.          %dnode    Destination node
  210.          %dpoint   Destination point
  211.          %daddress Destination address
  212.          %from     Name of the message sender
  213.          %ffrom    First name of the message sender
  214.          %lfrom    Last name of the message sender
  215.          %zone     Origin zone
  216.          %net      Origin net
  217.          %node     Origin node
  218.          %point    Origin point
  219.          %address  Origin address
  220.          %date     Current date
  221.          %file     The name of the attached file
  222.          %size     Size of the attached file in kb
  223.          %bsize    Size of the attached file in bytes
  224.  
  225.  
  226.     Node interaction
  227.          Almost exactly as for AreaFix. Messages must be addressed to
  228.          "FileFix", the subject field contains the node's password, and -
  229.          optionally - the switches '-l' (list available files for node)
  230.          and/or '-q' (list connected files for node) and/or '-r' (send the
  231.          latest version of the file(s) listed in the body of the message).
  232.          The message body contains zero or more magic filenames (one per
  233.          line). If a magic filename is prefixed by a dash ('-'), the node
  234.          is disconnected from the file, otherwise it is connected. For more
  235.          information, check the FILEFIX.USE in the distribution archive.
  236.  
  237.  
  238.     Errorlevels
  239.          0    Normal run
  240.          1    Commandline error
  241.          2    Fatal error
  242.  
  243.  
  244.     Groups
  245.          Each file in FileFix.Cfg has a group-tag. Each node in FileFix.Cfg
  246.          is a member of one or more groups. The nodes can only access files
  247.          with group-tags that are in their member list.
  248.  
  249.  
  250.     Batch
  251.          There is a few things to keep in mind when utilizing the 'Batch'
  252.          statement.
  253.            o  You will have less memory available than usually, unless you
  254.               use swapping - typically FileFix will occupy 100 kb of memory
  255.               while executing your batch sequence, although it will depend
  256.               on your configuration.
  257.            o  Your 'COMSPEC' environment variable should be set correctly,
  258.               that is, it should tell FileFix where COMMAND.COM (or 4Dos or
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.  
  269.  
  270.  
  271.               whatever you use) is located.
  272.            o  If you have a TMP or TEMP environment variable, it must point
  273.               to a location where it is possible for FileFix to create a
  274.               file. If none of these variables are set, FileFix will create
  275.               the batch-file in the current directory of the current drive.
  276.            o  Never delete or rename the file that FileFix is working on
  277.               (%1). FileFix will get utterly confused if you do. It is,
  278.               however, ok to manipulate the files in other ways, such as
  279.               changing its date or size.
  280.          FileFix will automatically restore current drive and directory
  281.          when it has executed a batch sequence, so you need not to restore
  282.          them.
  283.  
  284.  
  285.     Keeping things simple
  286.          I do not intend to add mailer-/BBS-specific code to FileFix - it
  287.          has no such specific code now, except that it assumes that .MSG
  288.          files are used for netmail, and that Files.Bbs/Files.Gbs files are
  289.          used for the file-area listings - this keeps it nice & simple, and
  290.          I'd very much like it to stay that way.
  291.          In particular, I'm not going to add code for scanning logfiles.
  292.          There are some 10 different mailers in use - which means 10
  293.          different logformats - verrry messy.
  294.          Also, I won't add any particular support for static packers. This
  295.          would make FileFix more mailer specific and furthermore I don't
  296.          feel that static packing is the way to go. (I wouldn't add code
  297.          for automatic launching of nuclear weapons either).
  298.  
  299.  
  300.     Notes
  301.          You should not change the order of the statements in FileFix.Cfg -
  302.          keep them in the same order as in the supplied FileFix.Cfg. This
  303.          is because the configuration file parser in FileFix is single-
  304.          pass, in other words it must be able to resolve everything at
  305.          once. So, for instance, if you have a 'Batch Z2-DIFF' statement
  306.          before the 'Z2-DIFF' file is defined, FileFix will get all exited
  307.          and claim that it can't find a definition of Z2-DIFF.
  308.  
  309.          The %cookie string in filefix.msg requires that you have created a
  310.          cookie file for FileFix. Get hold of Cookie Construction Kit
  311.          (usually CCK.ZIP), if you want to use %cookie.
  312.  
  313.          This piece of software is a joint work between Martin Joench
  314.          (2:231/36) and myself. Martin and I got the idea for this program
  315.          at the same time. It would never have come into existence without
  316.          the other part - Martin kept telling me that I should write it,
  317.          and I wrote the program.
  318.  
  319.  
  320.     Warranty
  321.          Absolutely none. If you are the type of person that gets pissed
  322.          because of destructive bugs, then you shouldn't be using a
  323.          computer anyway.
  324.  
  325.  
  326.  
  327.  
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.  
  335.  
  336.  
  337.     BeerWare
  338.          If you use this software on a regular basis, you are suggested to
  339.          offer me a beer should we ever meet in person.
  340.  
  341.  
  342.     Author:        Stig Jacobsen
  343.     BBS:           +45-31319734
  344.     FidoNet:       2:231/16
  345.     InterNet:      shj@login.dkuug.dk
  346.     SnailMail:     Stig Jacobsen
  347.                    Mysundegade 18, st.
  348.                    1668 Copenhagen V
  349.                    Denmark
  350.  
  351.  
  352.                                    EOF 
  353.  
  354.  
  355.  
  356.  
  357.  
  358.  
  359.  
  360.  
  361.  
  362.  
  363.  
  364.  
  365.  
  366.  
  367.  
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.  
  394.  
  395.  
  396.  
  397.